I just gave this one a try, and noticed that the config does not work initially, due to the usage of yaml.github as a filetype. While I get the idea to not start this language server on every yaml file, I do not think that the filetype yaml.github is automatically in nvim by default? I have to manually set them in my github action files, at least.

I just gave this one a try, and noticed that the config does not work initially, due to the usage of yaml.github as a filetype. While I get the idea to not start this language server on every yaml file, I do not think that the filetype yaml.github is automatically in nvim by default? I have to manually set them in my github action files, at least.

that's true. I recommend defining this pattern for GitHub workflows:

vim.filetype.add({
  pattern = {
    ['.*/%.github[%w/]+workflows[%w/]+.*%.ya?ml'] = 'yaml.github',
  },
})

We would either have to upstream this into Neovim core ftdetect or add a section to the docs

We would either have to upstream this into Neovim core ftdetect or add a section to the docs

The docs item in these configs is intended for that, it's definitely worth mentioning there.